docs: remove cargo test workspace command #1048
Conversation
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
WalkthroughThe recent update focuses on modifying the command used to run unit tests in Rust within the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
docs/v0.8/en/contributor-guide/tests/unit-test.md (1)
6-6: Typographical correction."The default test runner ships with
cargois a bit slow" should be corrected to "The default test runner that ships withcargois a bit slow".- The default test runner ships with `cargo` is a bit slow + The default test runner that ships with `cargo` is a bit slowdocs/nightly/en/contributor-guide/tests/unit-test.md (1)
10-11: Typographical correction."The default test runner ships with
cargois not supported in our codebase" should be corrected to "The default test runner that ships withcargois not supported in our codebase".- The default test runner ships with `cargo` is not supported in our codebase + The default test runner that ships with `cargo` is not supported in our codebase
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (8)
- docs/nightly/en/contributor-guide/getting-started.md (1 hunks)
- docs/nightly/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/nightly/zh/contributor-guide/getting-started.md (1 hunks)
- docs/nightly/zh/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/en/contributor-guide/getting-started.md (1 hunks)
- docs/v0.8/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/zh/contributor-guide/getting-started.md (1 hunks)
- docs/v0.8/zh/contributor-guide/tests/unit-test.md (1 hunks)
Files skipped from review due to trivial changes (3)
- docs/nightly/en/contributor-guide/getting-started.md
- docs/nightly/zh/contributor-guide/getting-started.md
- docs/v0.8/en/contributor-guide/getting-started.md
Additional comments not posted (10)
docs/nightly/zh/contributor-guide/tests/unit-test.md (2)
6-6: Clarify the necessity of--workspacewithcargo nextest run.The statement "Since
GreptimeDBorchestrates its components in the 'workspace' manner, the tailing--workspaceis necessary to run all the unit cases." is conflicting with the subsequent statement that--workspaceis not necessary withcargo nextest run. Please clarify this.
6-6: Ensure translation consistency.Ensure that the translation accurately reflects the intent of the original English documentation. For example, "The default test runner ships with
cargois a bit slow" should be correctly translated to convey the same meaning in Chinese.docs/v0.8/en/contributor-guide/tests/unit-test.md (1)
6-6: Clarify the necessity of--workspacewithcargo nextest run.The statement "Since
GreptimeDBorchestrates its components in the 'workspace' manner, the tailing--workspaceis necessary to run all the unit cases." is conflicting with the subsequent statement that--workspaceis not necessary withcargo nextest run. Please clarify this.docs/nightly/en/contributor-guide/tests/unit-test.md (1)
6-6: Clarify the necessity of--workspacewithcargo nextest run.The statement "Since
GreptimeDBorchestrates its components in the 'workspace' manner, the tailing--workspaceis necessary to run all the unit cases." is conflicting with the subsequent statement that--workspaceis not necessary withcargo nextest run. Please clarify this.docs/v0.8/zh/contributor-guide/tests/unit-test.md (2)
6-6: Clarify the necessity of--workspacewithcargo nextest run.The statement "Since
GreptimeDBorchestrates its components in the 'workspace' manner, the tailing--workspaceis necessary to run all the unit cases." is conflicting with the subsequent statement that--workspaceis not necessary withcargo nextest run. Please clarify this.
6-6: Ensure translation consistency.Ensure that the translation accurately reflects the intent of the original English documentation. For example, "The default test runner ships with
cargois not supported in our codebase" should be correctly translated to convey the same meaning in Chinese.docs/v0.8/zh/contributor-guide/getting-started.md (4)
46-47: Introduction of nextest is clear and accurate.The introduction of the nextest tool for running unit tests is clear and provides adequate context.
48-55: Installation instructions for nextest are accurate and complete.The instructions for installing nextest using cargo and alternative methods are correct and provide sufficient details for users to follow.
56-59: Instructions for running the test suite with nextest are clear and correct.The command to run the test suite using nextest is accurate and the instruction is clear.
46-59: The changes maintain the logical flow and consistency of the document.The document remains cohesive and the changes do not disrupt the overall structure.
Deploying greptime-docs with
|
| Latest commit: |
31a96ec
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ba545168.greptime-docs.pages.dev |
| Branch Preview URL: | https://update-test-doc.greptime-docs.pages.dev |
Co-authored-by: Yingwen <realevenyag@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
docs/nightly/zh/contributor-guide/tests/unit-test.md (1)
9-9: Consider using "accelerate" instead of "speed up".To strengthen the wording, consider using "accelerate" the test procedure.
- to speed up the test procedure. + to accelerate the test procedure.Tools
LanguageTool
[style] ~9-~9: Consider using a different verb to strengthen your wording.
Context: ...o usenextestto speed up the test procedure. You can install it ...(SPEED_UP_ACCELERATE)
docs/v0.8/en/contributor-guide/tests/unit-test.md (1)
9-9: Consider using "accelerate" instead of "speed up".To strengthen the wording, consider using "accelerate" the test procedure.
- to speed up the test procedure. + to accelerate the test procedure.Tools
LanguageTool
[style] ~9-~9: Consider using a different verb to strengthen your wording.
Context: ...o usenextestto speed up the test procedure. You can install it ...(SPEED_UP_ACCELERATE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/nightly/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/nightly/zh/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/zh/contributor-guide/tests/unit-test.md (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- docs/nightly/en/contributor-guide/tests/unit-test.md
- docs/v0.8/zh/contributor-guide/tests/unit-test.md
Additional context used
LanguageTool
docs/nightly/zh/contributor-guide/tests/unit-test.md
[style] ~9-~9: Consider using a different verb to strengthen your wording.
Context: ...o usenextestto speed up the test procedure. You can install it ...(SPEED_UP_ACCELERATE)
docs/v0.8/en/contributor-guide/tests/unit-test.md
[style] ~9-~9: Consider using a different verb to strengthen your wording.
Context: ...o usenextestto speed up the test procedure. You can install it ...(SPEED_UP_ACCELERATE)
Additional comments not posted (2)
docs/nightly/zh/contributor-guide/tests/unit-test.md (1)
6-6: LGTM! Accurate update to the test command.The change from
cargo test --workspacetocargo nextest runis correctly reflected.docs/v0.8/en/contributor-guide/tests/unit-test.md (1)
6-6: LGTM! Accurate update to the test command.The change from
cargo test --workspacetocargo nextest runis correctly reflected.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
docs/nightly/en/contributor-guide/tests/unit-test.md (1)
8-8: Add missing article "the".The sentence is missing the article "the" before "GreptimeDB codebase".
- The default test runner ships with `cargo` is not supported in GreptimeDB codebase. It's recommended + The default test runner ships with `cargo` is not supported in the GreptimeDB codebase. It's recommendedTools
LanguageTool
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ... ships withcargois not supported in GreptimeDB codebase. It's recommended to use [`nex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/nightly/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/nightly/zh/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/en/contributor-guide/tests/unit-test.md (1 hunks)
- docs/v0.8/zh/contributor-guide/tests/unit-test.md (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- docs/nightly/zh/contributor-guide/tests/unit-test.md
- docs/v0.8/en/contributor-guide/tests/unit-test.md
- docs/v0.8/zh/contributor-guide/tests/unit-test.md
Additional context used
LanguageTool
docs/nightly/en/contributor-guide/tests/unit-test.md
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ... ships withcargois not supported in GreptimeDB codebase. It's recommended to use [`nex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Additional comments not posted (3)
docs/nightly/en/contributor-guide/tests/unit-test.md (3)
6-6: LGTM!The update to use
cargo nextest runis correct and aligns with the objective of updating the test command.
9-9: LGTM!The recommendation to use
nextestand the link to its documentation are correct and useful.
Line range hint
12-13:
LGTM!The instructions on running tests with
cargo nextest runand the notes about installation issues are correct and useful.Tools
LanguageTool
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ... ships withcargois not supported in GreptimeDB codebase. It's recommended to use [`nex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Signed-off-by: Ruihang Xia <waynestxia@gmail.com> Co-authored-by: Yiran <cuiyiran3@gmail.com> Co-authored-by: Yingwen <realevenyag@gmail.com>
What's Changed in this PR
Describe the change in this PR
Related to GreptimeTeam/greptimedb#4324
Checklist
summary.ymlmatches the current document structure when you changed the document structure.Summary by CodeRabbit
cargo nextest runfor running Rust unit tests, improving test execution speed.